home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / telecomm / ums / setfolder1_1.lha / SetFolder / SetFolder_english.doc < prev    next >
Encoding:
Text File  |  1994-12-13  |  8.9 KB  |  297 lines
  1. SetFolder 1.1 - Documentation
  2. *****************************
  3.  
  4. Copyright
  5. *********
  6.  
  7.    SetFolder (C) 1994 kMel, Klaus Melchior
  8.  
  9.    This program is freely distributable, but copyrighted by me.  This
  10. means you may freely copy it as long as you do not charge more than a
  11. nominal fee for copying.  This program may be put on PD disks,
  12. especially on Fred Fish's AmigaLibDisks and Fred's CDROMs.  If you want
  13. to distribute this program you MUST keep this document with it.  The
  14. program and the documents must be distributed in their original
  15. unmodified form.
  16.  
  17.    This program cannot be used for commercial purposes without written
  18. permission by the author.  The author can not be made responsible for
  19. any damage which is caused by using this program.
  20.  
  21.    Send comments, suggestions or bug reports, and the gifts to:
  22.  
  23.      Klaus Melchior, Schulstrasse 17
  24.      D-52156 Monschau, Germany
  25.      Phone: +49 (0)2472 4710
  26.      
  27.      DE:   kmel@eifel.oche.de
  28.      ADSP: kmel@eifel.adsp.sub.org
  29.      FIDO: 2:242/158.2@fidonet
  30.      DE:   kmel@cwg.fido.de
  31.  
  32. What is SetFolder ?
  33. *******************
  34.  
  35.    SetFolder is an UMS tool, which scans the message base for
  36. non-foldered mails, checks their contents and if necessary set them to
  37. a folder.
  38.  
  39.    The configuration of SetFolder is stored in 'ums.config'. A fast
  40. algorithm is used to check the conditions, large UMS fields can be cut.
  41. The age of the mails which should be checked is setable. Mails of
  42. mailinglists are recognized and automatically set to their folder.
  43. When setting a folder, the reply can also be set.
  44.  
  45.    Background: I subscribed over 10 mailinglists and sort them to
  46. folders with 'sumsfolder', but this takes a lot of time. Many of them
  47. are recognized using a pattern, so every new mail must be read, the text
  48. or comments must be checked. This procedure is started again and again
  49. for each mailinglist :-C
  50.  
  51.    So I decided to write SetFolder.
  52.  
  53.    After SetFolder is started, it knows all UMS fields with an index,
  54. the mails with this fields are checked quickly. Then it checks the other
  55. mails by reading mail after mail, but only one time. To do this fast,
  56. it isn't going from folder to folder.
  57.  
  58.    It is possible to look for mailinglist mails. When the FromName or
  59. ReplyName of mails matches the pattern "mailinglist '#?'", which is
  60. used by several mailinglists, the mailinglist name is stripped and used
  61. as folder name (see Arguments). It works like "mlist2folder.rexx".
  62.  
  63.    Several mailinglists don't set the right or no reply name and
  64. address.  SetFolder can repair this, when the folder is recognized, you
  65. can also set the ReplyName and the ReplyAddr.
  66.  
  67. CLI arguments
  68. *************
  69.  
  70.    TEMPLATE:
  71.      USER/A,PASSWORD/A,SERVER/K,
  72.      AGE/K/N,CHECKLEN/K/N,MLIST/S,NOTOWNER/S,TEST/S,
  73.      DELAY/K/N,NOPROGRESS/S,QUIET/S
  74.  
  75. AGE/K/N
  76.      mails which age is younger than the defined number of days are
  77.      checked, default: 0 days, only the new ones
  78.  
  79. DELAY/K/N
  80.      use SetFolder as background task, all actions are delayed, low task
  81.      priority, set here the time for Delay() in 1/50 sec
  82.  
  83. NOPROGRESS/S
  84.      the progress indicator isn't shown
  85.  
  86. MLIST/S
  87.      mailinglist mails are recognized
  88.  
  89. NOTOWNER/S
  90.      only mails are checked, which UMS owner flag isn't set
  91.  
  92. PASSWORD/A
  93.      password of the user
  94.  
  95. QUIET/S
  96.      no output text
  97.  
  98. SERVER/K
  99.      name of the server, optional
  100.  
  101. TEST/S
  102.      switches SetFolder into test mode, no folders are set
  103.  
  104. CHECKLEN/K/N
  105.      the UMS fields are cut, set here the number of bytes, which are
  106.      checked with MatchPattern(), sometimes useful with MsgText or
  107.      Comments
  108.  
  109. USER/A
  110.      user name
  111.  
  112. UMS Fields
  113. **********
  114.  
  115.    These names of UMS fields are checked by SetFolder:
  116.  
  117.      MsgText
  118.      FromName
  119.      FromAddr
  120.      ToName
  121.      ToAddr
  122.      MsgID
  123.      Subject
  124.      Comments
  125.      Organization
  126.      ReplyName
  127.      ReplyAddr
  128.      LogicalToName (UMSV11)
  129.      LogicalToAddr (UMSV11)
  130.  
  131.    Check your config! SetFolder gives you a warning if an UMS field
  132. isn't recognized (see Installation).
  133.  
  134. What you need !
  135. ***************
  136.  
  137.    - Kickstart >= 2.0
  138.  
  139.    - Workbench >= 2.0
  140.  
  141.    - UMS (Universal Message System) >= v10 (see: References)
  142.  
  143.    - Several additions in 'ums.config' (see: Installation)
  144.  
  145. How to install
  146. **************
  147.  
  148. Binaries
  149. ========
  150.  
  151.    Copy the "bin/" files to a place where all the executables of UMS are
  152. stored, normally this is "Mail:bin" or "Fido:bin/".
  153.  
  154.      copy bin/#? Mail:bin/
  155.  
  156. UMS config
  157. ==========
  158.  
  159.    Only one UMS config variables must be set global:
  160.  
  161. setfolder.Folder
  162.      It could contain several lines with the folder name, the UMS field,
  163.      which is checked (see: UMS Fields), the data and an optional
  164.      reply. One condition per line, four arguments seperated with at
  165.      least one space.
  166.  
  167.           <FolderName> <UMS Field> <Text/Pattern> [<ReplyName>,<ReplyAddr>]
  168.  
  169.      A ; in front of the FolderName marks the line as comment.
  170.  
  171. Example
  172. =======
  173.  
  174.      UMS v10 ------------------------------------------
  175.      setfolder.Folder = "
  176.          mui                Comments   *"#?(To|Cc):#?mui@taloa.unice.fr#?*" *"mui,mui@taloa.unice.fr*"
  177.          aminet             FromAddr   *"aminetd@wuarchive.wustl.edu*"
  178.          meeting            ReplyName  *"Mailinglist 'Meeting'*"
  179.          ; comment
  180.          music.paperlate    MsgText    *"#?(To|Cc):#?paperlate@atom#?*"
  181.          trash              Subject    *"Point-Beitrag*"
  182.      "
  183.      --------------------------------------------------
  184.      
  185.      UMS v11 ------------------------------------------
  186.      ( setfolder.Folder
  187.          "mui                Comments   \"#?(To|Cc):#?mui@taloa.unice.fr#?\" \"mui,mui@taloa.unice.fr\"\n"
  188.          "aminet             FromAddr   \"aminetd@wuarchive.wustl.edu\"\n"
  189.          "meeting            ReplyName  \"Mailinglist 'Meeting'\"\n"
  190.          "; comment\n"
  191.          "music.paperlate    MsgText    \"#?(To|Cc):#?paperlate@atom#?\"\n"
  192.          "trash              Subject    \"Point-Beitrag\"\n"
  193.        )
  194.      --------------------------------------------------
  195.  
  196. History of SetFolder
  197. ********************
  198.  
  199.  
  200.            27.08.94  * initial
  201.                      * first working version
  202.                      + busy ascii routines
  203.      
  204.            28.08.94  + documentation
  205.       0.1            * beta to [ah] [mh]
  206.      
  207.            30.08.94  + documentation changed
  208.       0.2            * beta to [cr] [fd] [op]
  209.      
  210.            05.09.94  + NOPROGRESS/S implemented, progress indicator can be
  211.                        switched off [op]
  212.                      + AGE/K/N implemented, old mails can be checked [op]
  213.                      + documentation changed
  214.      
  215.       0.3  07.09.94  * beta to [cv] [op]
  216.      
  217.            06.10.94  * first feedback :-C
  218.      
  219.            08.10.94  + CHECKLEN/K/N implemented
  220.      
  221.            11.10.94  + NOTOWNER/S added [ah]
  222.      
  223.       1.0  12.10.94  * release to aminet
  224.      
  225.            10.11.94  + mailinglist recognition, MLIST/S added [ms]
  226.        b1            * beta to [ms]
  227.      
  228.            12.11.94  - fixed bug in mailinglist name routine [ms]
  229.                      + CTRL-C works now
  230.        b2            * beta to [ms]
  231.      
  232.            19.11.94  - fixed bug in folder routine
  233.      
  234.            21.11.94  + insert ReplyName, ReplyAddr (option) [ss]
  235.        b3            * beta to [ss] [ah]
  236.      
  237.            23.11.94  - fixed bug after reading corrupt message [ms]
  238.        b4            * beta to [ms]
  239.      
  240.            06.12.94  - fixed bug in mlist routine [ms]
  241.        b5            * beta to [ms]
  242.      
  243.       1.1  13.12.94  * release to aminet
  244.  
  245. What is to do in future ?
  246. *************************
  247.  
  248.    - ability to write a report
  249.  
  250. References
  251. **********
  252.  
  253. UMS
  254.      UMS - Universal Message System (c) Copyright 1992-94 by Martin
  255.      Horneffer
  256.  
  257.      Aminet: comm/ums/      *Note* v11 is not yet available
  258.  
  259. Thanks are going to ...
  260. ***********************
  261.  
  262.    - Martin Horneffer [mh] for UMS
  263.  
  264.    - Andreas Harrenberg [ah], Christian Rütgers [cr], Olaf Peters [op],
  265.      Frank Duerring [fd], Christoph Viethen [cv], Matthias Scheler [ms],
  266.      Stefan Stuntz [ss]
  267.  
  268.    - and all I forgot to mention ...
  269.  
  270. Index
  271. *****
  272.  
  273.  
  274.  
  275.  Arguments                              Arguments
  276.  Authors address                        Copyright
  277.  Bug reports                            Copyright
  278.  Changes in 'ums.config'                Installation
  279.  CLI arguments                          Arguments
  280.  Comments                               Copyright
  281.  Copyright                              Copyright
  282.  Credits                                Credits
  283.  Description                            Description
  284.  Distribution                           Copyright
  285.  E-Mail                                 Copyright
  286.  History                                History
  287.  Installation                           Installation
  288.  References                             References
  289.  Requirements                           Requirements
  290.  SetFolder                              Description
  291.  Template                               Arguments
  292.  Thanks                                 Credits
  293.  ToDo                                   ToDo
  294.  UMS Fields                             UMS Fields
  295.  UMS variables                          Installation
  296.  
  297.